Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Renaming according to convention #74

Closed
wants to merge 34 commits into from
Closed

Renaming according to convention #74

wants to merge 34 commits into from

Conversation

nawarani
Copy link
Contributor

All package, class, method and variable names have been refactored. I have ran the game, and tried the following to see if they work

  • all piece movement
  • capture
  • en passant
  • check
  • castling
  • leaderboard
  • forfeit
  • draw

Naming conventions used (in accordance with Java conventions)

  • package names are all lowercase, multiple words becomes concatenated. i.e Frameworks_and_Drivers -> frameworksanddrivers
  • Class names start with uppercase and continue in camelCase. i.e. LocationBitboard
  • method and variable names start lowercase and continue in camelCase. i.e. whitePawnAttacks() and whitePawnAttacks
  • constants are all uppercase separated by underscores. I have verified the use of underscore for constants with the java conventions. i.e. WHITE_PAWN

The tests currently don't run because they can't import the packages for some reason. I'm having trouble fixing this, if anyone has some time, please take a look.
Please pull and run the branch before merging to ensure none of the original functionality has been compromised.

@nawarani nawarani added this to the Milestone #4 milestone Aug 11, 2023
AscendedWise
AscendedWise reviewed Aug 11, 2023
View reviewed changes
Copy link
Contributor

@AscendedWise AscendedWise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does

  • "Constants"
  • "Pieces"
  • "View"
  • "Entities"
    also have to be all lower case to adhere with java conventions proper naming of packages/folders

@123Chan
Copy link
Contributor

123Chan commented Aug 12, 2023

I agree with AscendedWise for the package/folders naming. For the program and tests not running, try

  • Build->Rebuild Project

in IntelliJ.

@nawarani nawarani linked an issue Aug 12, 2023 that may be closed by this pull request
Renaming files #73
Closed
123Chan
123Chan approved these changes Aug 13, 2023
View reviewed changes
Copy link
Contributor

@123Chan 123Chan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I like that you went back to change the naming conventions in tests as well.

123Chan
123Chan requested changes Aug 13, 2023
View reviewed changes
Copy link
Contributor

@123Chan 123Chan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check if the all the documentations are still there.

123Chan
123Chan approved these changes Aug 13, 2023
View reviewed changes
Copy link
Contributor

@123Chan 123Chan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see anything weird anymore. I approve.

@123Chan 123Chan closed this Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AscendedWise AscendedWise AscendedWise left review comments

@123Chan 123Chan 123Chan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Milestone #4
Development

Successfully merging this pull request may close these issues.

Renaming files
3 participants
@nawarani @123Chan @AscendedWise